home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1995 October / EnigmA AMIGA RUN 01 (1995)(G.R. Edizioni)(IT)[!][issue 1995-10][Aminet 7].iso / Aminet / comm / bbs / maximv10.lha / read_me < prev   
Text File  |  1995-04-04  |  14KB  |  323 lines
  1.  
  2. MAXiMAIL V1.0
  3. QWK format Mail Door for MAXs BBS V1.52+
  4. Copyright by Keith Bennett 1995.
  5. Please report bugs to Keith Bennett at:
  6. Local    : Studio-101 BBS +61-3-7048260
  7. FidoNet  : 3:638/111
  8. Internet : keith.bennett@empire.apana.org.au
  9. I also read the MAXsNet Support echo daily
  10.  
  11. *** INTRODUCTION:
  12.  
  13. MAXiMAIL is a QWK format mail door for M A X's BBS V1.52+. It generates a
  14. mail packet containing select messages, then downloads the packet to the
  15. User's computer. The User can then read and reply to the messages offline, 
  16. at their leisure, using a QWK offline mail reader. This minimizes the time 
  17. a User spends online searching through, reading and replying to messages
  18. and can also save your Users a lot of money in phone bills.
  19.  
  20. *** GETTING IT GOING:
  21.  
  22. - Create a new directory in your Doors directory called MAXiMAIL
  23.  
  24. - Copy all MAXiMAIL files into this directory
  25.  
  26. - Create a new directory in the MAXiMAIL directory called TEMP
  27.   (This is where the mail packet files are created)
  28.  
  29. - From CLI run the CONFIG program (see below) 
  30.  
  31. - Make sure you have the necessary archivers in your C directory
  32.  
  33. - Make sure you have the Delete command in your C directory
  34.  
  35. - Set up a door function on M A X's BBS menus to run MAXiMAIL
  36.  
  37. - Edit the menu file called MAXiMAIL.Menu to suit your BBS style
  38.  
  39. - Set up M A X's BBS Distribution and Sections Windows (see below)
  40.  
  41. - Send me lots of money to register MAXiMAIL
  42.  
  43. *** UPGRADING FROM PREVIOUS VERSIONS
  44.  
  45. MAXiMAIL V0.1 - Delete all MAXiMAIL files and start again 
  46.  
  47. MAXiMAIL V0.2 - Keep the old MAXiMAIL.Users and MAXiMAIL.Config files 
  48.                 and replace the rest. Delete EQWKCONV and QuickQWK.Dat 
  49.                 and remove any system events that run EQWKCONV.
  50.                 Run the new Config program from CLI (hit Default)
  51.  
  52. *** MAXiMAIL LIMITS:
  53.  
  54. Minimum date             : 01-01-1978
  55. Maximum date             : 31-12-2077
  56. Maximum message sections : 100
  57. Maximum message size     : 16384 bytes
  58. Maximum messages         : 65535 (also limited by your HD space)
  59.  
  60. MAXiMAIL does not allow replies to Private Email (section 0). The
  61. reason for this is that if a NetMail message is replied to, there
  62. is no way to decide which outbound directory (or Hub) to send the
  63. reply to if the BBS is running multiple networks. 
  64.  
  65. *** MEMORY REQUIREMENTS:
  66.  
  67. MAXiMAIL directly uses RAM for the following applications
  68. MAXiMAIL program             : 11092 bytes
  69. MAXiMAIL configuration       :   452 bytes
  70. Message port to MAX's BBS    :   192 bytes
  71. Memory for the sections data :  6200 bytes
  72. Memory for Distribution data : 24800 bytes
  73. Memory for reading messages  : 32896 bytes
  74. Memory for MAXiMAIL.Users    :    64 bytes for each user + 64
  75.  
  76. So you only need under 100Kbytes free RAM to run MAXiMAIL.
  77.  
  78. *** MAXiMAIL FILES:
  79.  
  80. MAXiMAIL        - This is MAXiMAIL the door program
  81. MAXiMAIL.Menu   - The main menu, you can edit this to suit your BBS
  82. MAXiMAIL.Help   - Text file for online help
  83. MAXiMAIL.Users  - This file stores the Users settings
  84. MAXiMAIL.Inuse  - This dummy file is Locked when MAXiMAIL is in use
  85. MAXiMAIL.Reg    - Registration form for MAXiMAIL
  86. Config          - This program edits the config file (run from CLI)
  87. read_me         - You're looking at it now
  88. MAXiMAIL.Config - This file is created by running the Config program
  89. MAXiMAIL.pkt    - This file is generated in the FidoNet Inbound directory
  90.                   to Import QWK replies into MAX's message base.
  91.  
  92. The following files are generated in the Temp directory, they are deleted
  93. after a User downloads their mail packet. The Temp directory should be
  94. empty when the MAXiMAIL door is not in use.
  95.  
  96. CONTROL.DAT     - Is the QWK control file
  97. MESSAGES.DAT    - QWK format message file
  98. 0xx.NDX         - QWK index files (xx = message section number)
  99. PERSONAL.NDX    - Personal index file
  100. xxxxxxxx.QWK    - This is a LHA archive of the above QWK files, this is
  101.                   the file that gets downloaded. (xxxxxxxx = BBS ID)
  102.  
  103. To create the QWK packet MAXiMAIL also uses the following MAXs BBS files:
  104.  
  105. MAXsBBS.Config  - or the config file you specify from the Config program
  106. Message.text    - MAX's message text, must be in the Message file path
  107. Message.data    - MAX's message data, must be in the Message file path
  108.  
  109. *** PROGRAM NOTES
  110.  
  111. MAXiMAIL was written entirely in 68000 assembly language on an AMIGA 500.
  112. It uses the old version library functions so it should work on all Amiga
  113. models and all AmigaDOS and Kickstart versions.
  114. Is has been tested with MAX's BBS V1.52 and V1.54 and should work with new
  115. versions of MAXs BBS as long as the Message.text, Message.data and config 
  116. files are in the same format as V1.52.
  117. MAXiMAIL is a "Safe" program because it does not update any of MAX's files
  118. therefore it cannot corrupt your message base etc.
  119. It generates a minimum QWK format packet according to the QWK Mail Packet
  120. File Layout V1.5 document. The QWK message uploads are converted to the 
  121. FidoNet packet format according to the FidoNet Technical Specifications 
  122. FTS-0001 (V014) and FTS-0004.
  123.  
  124. The QWK format is Copyright 1987 by Sparkware.
  125. QWK Mail Packet File Layout document is Copyright 1992 by Patrick Y. Lee.
  126. FidoNet is a registered mark of Tom Jennings and Fido Software.
  127. M A X's BBS is Copyright 1992 by Anthony Barrett.
  128. MAXiMAIL is Copyright 1995 by Keith Bennett.
  129.  
  130. Many thanks to my best user Barry Hearn and to Mark Wesson from
  131. FireBase 1 BBS for extensive testing of MAXiMAIL.
  132.  
  133. *** SETTING UP THE DISTRIBUTION AND SECTIONS WINDOWS
  134.  
  135. Note: You only need to setup the following for the upload function to
  136.       work after registering MAXiMAIL. (See MAXiMAIL.Reg file)
  137.  
  138. MAXiMAIL imports QWK message replies by converting them to the FidoNet
  139. format and creating (or adding to) a file called MAXiMAIL.pkt in your
  140. FidoNet/Inbound directory. The messages are then imported via MAX's own
  141. FidoNet importer into MAX's message base during the next Import session. 
  142. For this to work with Local Message areas you need to Set up dummy echo 
  143. names in the distribution window for each of the local message areas and 
  144. turn on the Echo gadget for each local message area in the Sections 
  145. configure window. Also set up the reply access level for every message 
  146. section, Don't just leave them as 0 because MAXiMAIL uses the reply levels 
  147. to control the QWK reply access. eg:
  148.  
  149. FidoNet Mail Distribution
  150. ---------------------------------------------------------------------------
  151.     Sect:   Area:   Dest adrs:  Password:  Opt adrs:  Opt Origin: LZH: Old:
  152. 10: 12    LOC_SYSOP   0/0                    0/0      This BBS!    X    X
  153. 11: etc..    ^         ^                                 ^
  154.              |         |                                 |
  155. Put in a dummy         This must be left      You can put in a dummy origin
  156. area name for          as 0/0 on local        and here otherwise MAXiMAIL
  157. each local area.       message areas.         will use your default.
  158.  
  159. Note: Leave all current echo areas as they are.
  160.  
  161. Sections Configuration
  162. ---------------------------------------------------------------------------
  163.     Name: Lo Acc: Hi Acc: Rp Acc: Max: Frm:To: Del:Lk1:Lk2:Lk3:Als:Fil:Ech: 
  164. 12: Sysop  5       10000   5       99   /   /   X   /   X   X   X   X   /
  165. 13: etc..                  ^                                            ^
  166.                            |                                            |
  167. Make sure the reply access is              The Echo gadget must be set on
  168. set for every message section.             for all local message areas that
  169.                                            are available from MAXiMAIL.
  170.  
  171. Unfortunately this renders the message section links 100,103 and 106 
  172. useless because all message areas become echo areas. But from my own 
  173. experience these links don't get used much and a QWK door is a much 
  174. better way of reading messages.
  175.  
  176. *** CONFIGURING MAXiMAIL
  177.  
  178. From CLI change to the MAXiMAIL directory and type Config, this will bring
  179. up a window and you can edit the following parameters:
  180.  
  181. Config file    : This is the path to, and name of MAX's BBS Config file.
  182.                  (eg: BBS:MAXsBBS.Config)
  183. BBS Name       : The name of your BBS (32 characters max)
  184. BBS Location   : Location of BBS (Usually include State and Country)
  185. BBS Phone No   : Your primary BBS phone number
  186. Sysop name     : Your name or alias (32 characters max)
  187. BBS-ID         : This is a 1-8 character string that identifies your BBS, it
  188.                  is also used for the filename of the QWK mail packet so it
  189.                  must be in capitals and only use characters that are valid
  190.                  for IBM filenames. (eg: SUPERBBS) 
  191.                  Note: you cannot change the BBS-ID once MAXiMAIL has been
  192.                  registered so choose wisely!
  193. Registration No: This is MAXiMAIL's registration number, it must be 5 digits
  194.                  long. For un-registered use of MAXiMAIL enter 00000.
  195.  
  196. Compression Methods:
  197. MAXiMAIL will support up to 4 different compression methods, you must
  198. provide a name, archive command string and un-archive command string for
  199. each compression method you wish to use. To delete one of the methods just
  200. delete it's name, if a user has a deleted method selected they will be 
  201. prompted to select a new method next time they use MAXiMAIL.
  202.  
  203. Name : A 3 character name to represent the compression method (eg LHA,ZIP)
  204. Arch : Command string for archiving all files in path {p} and create file {f} 
  205. Unar : Command string for un-archiving all files in path {p} and output to
  206.        path {p}.
  207.  
  208. Basically any occurrence of {p} in the command string is replaced with 
  209. MAXiMAILs temp path. eg: BBS:Doors/MAXiMAIL/Temp/
  210. And any occurrence of {f} in the command string is replaced with the archived
  211. packet file name. eg: BBS:Doors/MAXiMAIL/Temp/SUPERBBS.QWK
  212. eg. for LZX Compression method:
  213. Name: LZX
  214. Arch: lzx -X0 a {f} {p}#?
  215. Unar: lzx -X0 x {p}#? {p}
  216.  
  217. The Buttons:
  218. Save   : Saves all changes to the MAXiMAIL.Config file and exits.
  219. Cancel : Exits without saving the changes.
  220. Default: Loads default compression methods for LHA and ZIP into compression
  221.          methods 1 and 2. You should use this button when initially setting
  222.          up MAXiMAIL. The default command strings have been tested with 
  223.          LHA V1.62, ZIP V2.0.1 and UNZIP V5.1.
  224.  
  225. *** RELEASE NOTES
  226.  
  227. V0.1 Released 10-Sep-1994 
  228.  
  229. - Released for Testing and Suggestions for improvement.
  230.  
  231. V0.2 Released 20-Sep-1994 
  232.  
  233. - Still a test version.
  234. - Bug fix with CONTROL.DAT file format
  235. - MAXiMAIL now checks if a download was successful, If not the User is
  236.   prompted to try again or abort
  237. - MAXiMAIL now remembers user's settings after downloading.
  238. - Added New messages only function.
  239. - When a user tags or untags all areas the area list is displayed again
  240. - All areas are Untagged for new MAXiMAIL users.
  241. - MAXiMAIL displays a "." for each 100 message scanned when creating the
  242.   QWK packet so users don't think the system has hung.
  243. - EQWKCONV facility added for fast QWK packet creation with big
  244.   message bases.
  245.  
  246. V0.3 Not Released (??-Oct-1994)
  247.  
  248. - Added access to Private Email (section 0). Normal Users will only
  249.   receive mail directed to them from this section, Users with an
  250.   access level of 5000 or more (Sysops) receive all Private Email.
  251. - Added PERSONAL.NDX file to QWK packet.
  252. - MAXiMAIL now runs on Multi-node BBS's
  253.  
  254. V0.4 Not Released (04-Nov-1994)
  255.  
  256. - Experimented with on-line QWK uploading directly into MAX's Message
  257.   base files. This worked ok but I decided there was too much risk of
  258.   corrupting the message base files. 
  259.  
  260. V0.5 Not Released (14-Feb-1995)
  261.  
  262. - Upload function working by creating an inbound FidoNet packet.
  263. - Increased on-line QWK packet creation speed.
  264. - Removed FidoNet control info from QWK messages.
  265. - MAXiMAIL now keeps an independent last message read pointer.
  266.  
  267. V0.6 Not Released (16-Feb-1995) 
  268.  
  269. - Increased on-line QWK packet creation speed again.
  270. - Removed EQWKCONV facilities.
  271. - CONTROL.DAT file now contains all areas available to the user, this
  272.   is so a user can write a new message (not reply) from their Offline
  273.   mailer to any of the message areas available to them.
  274. - Display number of messages in download packet before archiving.
  275. - Returns to MAXiMAIL Main Menu after downloading/uploading.
  276. - User settings are remembered whether they download or not.
  277.  
  278. V0.7b, Limited release for testing 26-Feb-1995
  279.  
  280. - A couple of cosmetic changes.
  281. - Informs user to wait while un-archiving replies.
  282. - Added an integrity check to annoy hackers. 
  283. - Added registration check.
  284.  
  285. V0.72b, Limited release for testing 04-Mar-1995 
  286.  
  287. - Bug Fix, some QWK offline mail readers didn't like the CONTROL.DAT
  288.   file format and reported it as corrupted.
  289. - CONTROL.DAT file now contains all areas selected by the user, this
  290.   stops the users getting a big list of message areas that they don't
  291.   want on their QWK offline mail reader.
  292. - Replies to Local message areas now show an origin line but no address. 
  293.  
  294. V0.73b, limited release for testing 04-Apr-1995
  295.  
  296. - Added multiple compression methods, up to 4 with configurable commands
  297. - The config program now uses a GUI interface.
  298.  
  299. V1.0, Released 05-Apr-1995
  300.  
  301. - The first full working release
  302.  
  303. *** MAXiMAIL.Users file format.
  304.  
  305. Offset:
  306.  
  307.       0 - File header
  308.      46 - Number of MAXiMAIL users in file (4 bytes)
  309.      50 - Nulls (14 bytes) 
  310.  
  311.  0   64 - Username, Null terminated (41 bytes)
  312. 41  105 - Compression method, 0-3 for method 1-4 (1 byte)
  313. 42  106 - Highest message read (4 bytes)
  314. 46  110 - Number of uploaded QWK packets (2 bytes)
  315. 48  112 - Number of downloaded QWK packets (2 bytes)
  316. 50  114 - Area selection flags (14 byte extra long word)
  317.           bit 0 = section 0, bit 1 = section 1, etc.
  318.           bits 100-112 are unused
  319.  
  320. 64  128 - Next record
  321.  
  322. *** EOF
  323.